ly.img:plugin-background-removal/ly.img.editor.plugin.backgroundRemoval/BackgroundRemovalPlugin

BackgroundRemovalPlugin

open class BackgroundRemovalPlugin : EditorConfigurationBuilder

Plugin for background removal. This plugin adds a button to the Dock that removes the background of the current page's image. Add InspectorBar.Button.rememberBackgroundRemoval with inspectorBarModifier to remove the background of the selected image or page. The results are PNG files in the app's cache directory, which Android can clear. To keep them, upload the file:// URIs that engine.editor.findAllMediaURIs() returns, and point the scene to the uploads with engine.editor.relocateResource.

Constructors

constructor()

Properties

assetLibrary

open var assetLibrary: ScopedProperty<EditorScope, AssetLibrary?>?

bottomPanel

open var bottomPanel: ScopedProperty<EditorScope, EditorComponent<*>?>?

canvasMenu

open var canvasMenu: ScopedProperty<EditorScope, EditorComponent<*>?>?

colorPalette

open var colorPalette: ScopedProperty<EditorScope, List<Color>?>?

config

var config: BackgroundRemovalConfig?

Background removal configuration object. Check BackgroundRemovalPlugin inheritors for available options.

dock

open override var dock: ScopedProperty<EditorScope, EditorComponent<*>?>?

Returns the editor dock with the background removal button inserted by dockModifier.

dockModifier

var dockModifier: HorizontalListBuilderModify<EditorComponent<*>>.(BackgroundRemovalConfig) -> Unit

The Dock modifier in order to place the Dock.Button.rememberBackgroundRemoval button. By default, it is prepended to the dock.

editorContext

val EditorConfigurationBuilder.editorContext: EditorContext

inspectorBar

open override var inspectorBar: ScopedProperty<EditorScope, EditorComponent<*>?>?

Returns the editor inspector bar with the background removal button inserted by inspectorBarModifier, or the parent's inspector bar when inspectorBarModifier is null.

inspectorBarModifier

var inspectorBarModifier: HorizontalListBuilderModify<EditorComponent<*>>.(BackgroundRemovalConfig) -> Unit?

The InspectorBar modifier in order to place the InspectorBar.Button.rememberBackgroundRemoval button. By default, it is null, and the plugin leaves the inspector bar unchanged. To prepend the button, set inspectorBarModifier = { addFirst { InspectorBar.Button.rememberBackgroundRemoval(config = it) } }.

navigationBar